IMotion.SimulateAxisRelative method

Calculates the duration a relative move takes to complete.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsReturn<McMoveDuration> SimulateAxisRelative(
       int Index,
       double Distance,
       double Velocity,
       double Acceleration,
       double Deceleration,
       double Jerk
)

Function SimulateAxisRelative(
       Index As Integer,
       Distance As Double,
       Velocity As Double,
       Acceleration As Double,
       Deceleration As Double,
       Jerk As Double
) As KsReturn(Of McMoveDuration)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Distance

Type: double

The relative distance for the motion. [unit]

Velocity

Type: double

A value of the maximum velocity. (not necessarily reached) [unit/second]

Acceleration

Type: double

A value of the acceleration. The unit is determined by McProfileType. (increasing power of the motor) [unit/second²] or [second]

Deceleration

Type: double

A value of the deceleration. The unit is determined by McProfileType. (decreasing power of the motor) [unit/second²] or [second]

Jerk

Type: double

A value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Return value

Type: KsReturn<McMoveDuration>

Returns a KsError code and an McMoveDuration value.

Examples

N/A

See also

IMotion Interface

IntervalZero.KINGSTAR.Base.Api Namespace